GH-50373: [Dev][Developer Tools] Add root AGENTS.md file#50375
GH-50373: [Dev][Developer Tools] Add root AGENTS.md file#50375thisisnic wants to merge 2 commits into
Conversation
github-actions
Bot
added
Component: Documentation
awaiting committer review
There was a problem hiding this comment.
Pull request overview
Adds a repository-root AGENTS.md to provide AI coding agents with shared, non-language-specific contribution workflow guidance for Apache Arrow.
Changes:
- Introduces
AGENTS.mdwith a high-level repository layout overview. - Documents Arrow’s issue/PR title conventions (including
GH-<id>:vsMINOR:). - Links to pre-commit usage, testing guidance, and AI-generated code policy resources.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
rok
left a comment
rok
left a comment
There was a problem hiding this comment.
I don't have experience writing AGENTS.md files. A couple of things that I'd like agents be good at for myself:
- setting up their own dev environment and not changing mine. But sometimes I'd want to use theirs.
- building implementations (e.g. C++ and R) so they can run tests
- running banchmarks
As per my experience they can already do these tasks, they are just not always consistent about it.
| ## Pull Request Conventions | ||
|
|
||
| ### Title Format | ||
|
|
There was a problem hiding this comment.
Should we link to PR template here instead? I suppose it's better for agents to have the .md file here, just noting a thought.
|
|
||
| ## Issue Conventions | ||
|
|
||
| - Prefix the issue title with the component name in brackets: |
There was a problem hiding this comment.
Similar to below - should we link to our issue templates?
github-actions
Bot
added
awaiting changes
|
Can we instead suggest that PRs should never be opened automatically by AI? Instead have the human review changes locally and write a proper description themselves? |
Rationale for this change
Help AI agents produce better PRs and conform to workflows
What changes are included in this PR?
Add AGENTS.md file at project root
Are these changes tested?
No
Are there any user-facing changes?
No